Platform Explorer / Nuxeo Platform 2021.50

Operation Retention.AttachRule (Attach Retention Rule)

Description

Attach the given retention rule to the input document. The document becomes a record and the main blob cannot be updated
Operation id Retention.AttachRule
Category Retention
Label Attach Retention Rule
Requires
Since

Parameters

Name Description Type Required Default value
rule document yes  

Signature

Inputs document, documents
Outputs document, documents

Implementation Information

Implementation Class Class: org.nuxeo.retention.operations.AttachRetentionRule
Contributing Component org.nuxeo.retention.operations

JSON Definition

{
  "id" : "Retention.AttachRule",
  "label" : "Attach Retention Rule",
  "category" : "Retention",
  "requires" : null,
  "description" : "Attach the given retention rule to the input document. The document becomes a record and the main blob cannot be updated",
  "url" : "Retention.AttachRule",
  "signature" : [ "document", "document", "documents", "documents" ],
  "params" : [ {
    "name" : "rule",
    "description" : null,
    "type" : "document",
    "required" : true,
    "widget" : null,
    "order" : 0,
    "values" : [ ]
  } ]
}